package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.SocCheckItemAddDTO;
import org.jsola.hr.dto.SocCheckItemUpdateDTO;
import org.jsola.hr.query.SocCheckItemQuery;
import org.jsola.hr.vo.SocCheckItemListVO;
import org.jsola.hr.vo.SocCheckItemVO;
import org.springframework.core.io.Resource;
import org.springframework.http.ResponseEntity;

import java.util.List;

/**
 * 校验子项表
 *
 * @author zhr
 */
@Api(tags = "hr-校验子项表")
public interface ISocCheckItemControllerAPI {

    /**
     * 新增校验子项表
     * @param socCheckItemAddDTO 校验子项表新增实体
     * @return 校验子项表展示对象
     */
    @ApiOperation(value = "新增校验子项表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socCheckItemAddDTO", dataType = "SocCheckItemAddDTO", value = "新增校验子项表", paramType = "body")
    })
    Result<SocCheckItemVO> save(SocCheckItemAddDTO socCheckItemAddDTO);


    /**
     * 修改校验子项表
     * @param socCheckItemUpdateDTO 校验子项表
     * @return 更新数量
     */
    @ApiOperation(value = "修改校验子项表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socCheckItemUpdateDTO", dataType = "SocCheckItemUpdateDTO", value = "修改校验子项表", paramType = "body")
    })
    Result<Integer> update(SocCheckItemUpdateDTO socCheckItemUpdateDTO);




    /**
     * 删除单个校验子项表，彻底删除
     * @param socCheckItemId 校验子项表id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个校验子项表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socCheckItemId", dataType = "String", value = "校验子项表id", paramType = "path")
    })
    Result<Integer> delete(String socCheckItemId);


    /**
     * 批量删除校验子项表，彻底删除
     * @param socCheckItemIds 校验子项表id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除校验子项表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socCheckItemIds", dataType = "String[]", value = "校验子项表id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] socCheckItemIds);


    /**
     * 根据校验子项表id查询校验子项表详情
     * @param socCheckItemId 校验子项表id
     * @return 校验子项表详情
     */
    @ApiOperation(value="根据校验子项表id查询校验子项表详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socCheckItemId", dataType = "String", value = "校验子项表id", paramType = "path")
    })
    Result<SocCheckItemVO> findById(String socCheckItemId);


    /**
     * 查询校验子项表
     * @param socCheckItemQuery 校验子项表查询参数
     * @return page
     */
    @ApiOperation(value="查询校验子项表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socCheckItemQuery", dataType = "SocCheckItemQuery", value = "校验子项表查询参数", paramType = "query")
    })
    Result<List<SocCheckItemListVO>> listAll(SocCheckItemQuery socCheckItemQuery);


     /**
     * 分页查询校验子项表
     * @param socCheckItemQuery 校验子项表查询参数
     * @return page
     */
    @ApiOperation(value="分页查询校验子项表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socCheckItemQuery", dataType = "SocCheckItemQuery", value = "校验子项表查询参数", paramType = "query")
    })
    Result<Page<SocCheckItemListVO>> page(SocCheckItemQuery socCheckItemQuery);

    /**
     * 校验子项表导出excel
     * @param socCheckItemQuery 校验子项表查询参数
     * @return excel
     */
    @ApiOperation(value = "校验子项表导出excel")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "socCheckItemQuery", dataType = "SocCheckItemQuery", value = "校验子项表查询参数", paramType = "query")
    })
    ResponseEntity<Resource> export(SocCheckItemQuery socCheckItemQuery);


}

